Update results.html - #1069
Conversation
Content tweaks as per service name from 'submit' to 'provide'
WalkthroughThe update modifies the results HTML template to replace all occurrences of "submit" and "submitting" with "provide" and "providing" regarding data checks. This change affects headings, paragraphs, and button text, but does not alter any logic, control flow, or data structures. Changes
Possibly related PRs
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Coverage Report
File CoverageNo changed files found. |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/views/check/results/results.html (1)
155-155: Minor grammar tweak suggested“…check if it is ready to provide” is a little clunky. Consider “ready to be provided”.
- <p>Fix the issues, then upload a new version of your data to check if it is ready to provide.</p> + <p>Fix the issues, then upload a new version of your data to check if it is ready to be provided.</p>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/views/check/results/results.html(4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: test
- GitHub Check: run-tests / test
🔇 Additional comments (1)
src/views/check/results/results.html (1)
141-145: Consistent wording change – LGTMThis block mirrors the earlier section and the phrasing reads naturally.
| <h2 class="govuk-heading-m">Issues you must fix before providing your data</h2> | ||
|
|
||
| <p>You cannot submit your data to the platform until you fix these issues.</p> | ||
| <p>You cannot provide your data to the platform until you fix these issues.</p> | ||
|
|
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Terminology swap looks correct – please sanity-check for any remaining “submit” phrases elsewhere
The updated heading and paragraph consistently use “provide”. Looks good in this block.
Run a quick search to make sure no other templates still tell users to “submit your data”:
🏁 Script executed:
#!/bin/bash
# Search all templates for residual “submit(ting) your data” wording
rg -n -i --context 2 'submit(ting)? your data'Length of output: 3279
Multiple residual “submit your data” occurrences found – please update to “provide your data” for consistency
A quick grep reveals these remaining instances:
• test/acceptance/request_check.test.js
– Line 111: You cannot submit your data until you fix the issues (update test assertion)
• src/views/submit/check-answers.html
– Line 29: <h1>Check your answers before submitting your dataset</h1>
– Line 140: <h2>Now submit your dataset</h2>
• src/views/organisations/get-started.html
– Line 181: Step title <span class="js-step-title">Submit your data</span>
– Line 188: Link text <a>Submit your data to the Planning Data Platform…</a>
• src/views/check/confirmation.html
– Line 31: ## 2: Submit your data
– Line 33: <a class="submit-link">Submit your data</a> to the Planning Data Platform…
• src/views/check/results/issueDetails.html
– Criteria labels:
• Level 2: You cannot submit your data until you fix the issues
• Level 3: You can submit your data and fix these issues later
Please revise these to use “provide your data” (or “submission” language as appropriate), and update the corresponding test expectations.
🤖 Prompt for AI Agents
In src/views/check/results/results.html around lines 128 to 131, update the
phrase "submit your data" to "provide your data" for consistency. Additionally,
apply this change to all listed files and lines, including
test/acceptance/request_check.test.js line 111,
src/views/submit/check-answers.html lines 29 and 140,
src/views/organisations/get-started.html lines 181 and 188,
src/views/check/confirmation.html lines 31 and 33, and
src/views/check/results/issueDetails.html for the specified criteria labels.
Also, update the corresponding test assertions to reflect this wording change.
There was a problem hiding this comment.
In src/views/check/results/results.html around lines 128 to 131, update the
phrase "submit your data" to "provide your data" for consistency. Additionally,
apply this change to all listed files and lines, including
test/acceptance/request_check.test.js line 111,
src/views/submit/check-answers.html lines 29 and 140,
src/views/organisations/get-started.html lines 181 and 188,
src/views/check/confirmation.html lines 31 and 33, and
src/views/check/results/issueDetails.html for the specified criteria labels.
Also, update the corresponding test assertions to reflect this wording change.
There was a problem hiding this comment.
🧩 Analysis chain
@stevenjmesser I'll help you update the terminology from "submit" to "provide" across all the identified files for consistency. Let me plan these changes:
Task: Update terminology from "submit" to "provide" across multiple files
- Update src/views/check/results/results.html around lines 128-131
- Update test/acceptance/request_check.test.js line 111
- Update src/views/submit/check-answers.html lines 29 and 140
- Update src/views/organisations/get-started.html lines 181 and 188
- Update src/views/check/confirmation.html lines 31 and 33
- Update src/views/check/results/issueDetails.html for criteria labels
- Ensure test assertions reflect the new wording
Once these changes are implemented, all the terminology will be consistent with "provide" instead of "submit" throughout the application templates and tests.
🏁 Script executed:
#!/bin/bash
# Get the current content of all files that need updating
echo "=== src/views/check/results/results.html around lines 128-131 ==="
sed -n '125,135p' src/views/check/results/results.html
echo -e "\n=== test/acceptance/request_check.test.js line 111 ==="
sed -n '108,114p' test/acceptance/request_check.test.js
echo -e "\n=== src/views/submit/check-answers.html lines 29 and 140 ==="
sed -n '26,32p' src/views/submit/check-answers.html
echo "..."
sed -n '137,143p' src/views/submit/check-answers.html
echo -e "\n=== src/views/organisations/get-started.html lines 181 and 188 ==="
sed -n '178,184p' src/views/organisations/get-started.html
echo "..."
sed -n '185,191p' src/views/organisations/get-started.html
echo -e "\n=== src/views/check/confirmation.html lines 31 and 33 ==="
sed -n '28,36p' src/views/check/confirmation.html
echo -e "\n=== src/views/check/results/issueDetails.html (searching for criteria labels) ==="
rg -n -A 2 -B 2 "cannot submit your data|can submit your data" src/views/check/results/issueDetails.html
Length of output: 3764
Perfect! I can see the current content of all the files. Let me check if there are any remaining "submit" instances in the results.html file that need updating:
🏁 Script executed:
#!/bin/bash
# Check for any remaining "submit" instances in results.html
echo "=== Checking for remaining 'submit' instances in results.html ==="
rg -n -i "submit" src/views/check/results/results.html
echo -e "\n=== Also checking the non-blocking issues section specifically ==="
sed -n '136,145p' src/views/check/results/results.html
Length of output: 751
Great! The results.html file is already fully updated with "provide" terminology. Let me update the plan to focus on the remaining files that still need changes:
Task: Update terminology from "submit" to "provide" across remaining files
- ✅ src/views/check/results/results.html - Already updated completely
- Update test/acceptance/request_check.test.js line 111
- Update src/views/submit/check-answers.html lines 29 and 140
- Update src/views/organisations/get-started.html lines 181 and 188
- Update src/views/check/confirmation.html lines 31 and 33
- Update src/views/check/results/issueDetails.html for criteria labels
The results.html file has already been completely updated with "provide" terminology. These changes will complete the terminology consistency across all the remaining files and their corresponding tests.
⏳ Preparing changes...
There was a problem hiding this comment.
A summary of the changes CodeRabbit can apply:
- Update multiple files by replacing all instances of "submit your data" with "provide your data" to ensure consistent terminology in user-facing text, including headings, links, criteria labels, and test assertions.
A summary of the context that CodeRabbit is considering across the codebase:
I need to examine the current content of the test file to understand the exact text being tested for assertion updates.
Show context details
Generated Script:
```shell
# Get the current content around line 111 in the test file
sed -n '108,114p' test/acceptance/request_check.test.js
**Shell Result:**
await page.getByText('description column is missing').click()
await page.waitForURL(//check/results/./issue/./, { timeout: 4000 })
await expect(page.getByText('Your data has issues')).toBeVisible()
await expect(page.getByText('You cannot submit your data until you fix the issues')).toBeVisible()
const itemsLocator = page.locator('.govuk-error-summary ul li')
expect(await itemsLocator.count()).toBe(1)
await expect(itemsLocator).toContainText('description column is missing')
</details>
> <rationale>I need to check the current content of the submit check-answers template to see the exact text on lines 29 and 140.</rationale>
<details>
<summary>Show context details</summary>
**Generated Script:**
# Get content around lines 29 and 140 in check-answers.html
sed -n '26,32p' src/views/submit/check-answers.html
echo "..."
sed -n '137,143p' src/views/submit/check-answers.html
**Shell Result:**
{% endif %}
<h1 class="govuk-heading-xl">
Check your answers before submitting your dataset
</h1>
{{ govukSummaryList({
...
}) }}
<h2 class="govuk-heading-m">
Now submit your dataset
</h2>
<p class="govuk-body">
</details>
> <rationale>I need to examine the get-started.html file to see the current content on lines 181 and 188.</rationale>
<details>
<summary>Show context details</summary>
**Generated Script:**
# Get content around lines 181 and 188 in get-started.html
sed -n '178,184p' src/views/organisations/get-started.html
echo "..."
sed -n '185,191p' src/views/organisations/get-started.html
**Shell Result:**
<span class="js-step-title">
Submit your data
</span>
</h2>
</div>
...
<div class="gem-c-step-nav__panel js-panel" id="step-panel-submit-your-data-4">
{% if 'submitEndpointForm' | isFeatureEnabled %}
<p class="gem-c-step-nav__paragraph"><a href="{{ organisation | endpointSubmissionFormToolDeepLink(dataset) }}">Submit your data</a> to the Planning
Data Platform. You need to provide your:</p>
<ul class="govuk-list govuk-list--bullet">
</details>
> <rationale>I need to check the confirmation.html file to see the current content on lines 31 and 33.</rationale>
<details>
<summary>Show context details</summary>
**Generated Script:**
# Get content around lines 31 and 33 in confirmation.html
sed -n '28,36p' src/views/check/confirmation.html
**Shell Result:**
{% if 'submitEndpointForm' | isFeatureEnabled %}
2: Submit your data
Submit your data to the Planning Data Platform. You need to provide your:
- full name
- work email address
</details>
> <rationale>I need to check the issueDetails.html file to find the criteria labels that need updating.</rationale>
<details>
<summary>Show context details</summary>
**Generated Script:**
# Search for criteria labels in issueDetails.html
rg -n -A 2 -B 2 "cannot submit your data|can submit your data" src/views/check/results/issueDetails.html
**Shell Result:**
31-
32-
33: {% set criteriaLabels = { '2': 'You cannot submit your data until you fix the issues', '3': 'You can submit your data and fix these issues later' } %}
34- {{ govukErrorSummary({
35- titleText: criteriaLabels[options.task.qualityCriteriaLevel] or 'There is a problem',
</details>
- [ ] <!-- {"checkboxId": "32599f3c-a2a5-4bb9-b887-dee90db62b97", "radioGroupId": "edit-actions-group-2189878674"} --> ✅ Create PR with these edits
- [ ] <!-- {"checkboxId": "85e7c9f1-3a23-4b8e-9f25-d7a5b234a8c1", "radioGroupId": "edit-actions-group-2189878674"} --> 📌 Create commit in current branch
- [ ] <!-- {"checkboxId": "6b3df8e2-79f5-4eb8-9d4a-c7d3a6a5f7b1", "radioGroupId": "edit-actions-group-2189878674"} --> 📋 Get copyable edits
<!-- <agentComponentType>plan-edits</agentComponentType> -->
<!-- <rawResChunk>Looking at the user request, I need to update the terminology from "submit your data" to "provide your data" across multiple files for consistency. I can see that the main `results.html` file has already been updated based on the diff shown. Now I need to update the remaining files identified in the verification agent's analysis.
<context>
<rationale>I need to examine the current content of the test file to understand the exact text being tested for assertion updates.</rationale>
<generated_script>
```shell
# Get the current content around line 111 in the test file
sed -n '108,114p' test/acceptance/request_check.test.js
</generated_script>
<shell_result>
await page.getByText('description column is missing').click()
await page.waitForURL(//check/results/./issue/./, { timeout: 4000 })
await expect(page.getByText('Your data has issues')).toBeVisible()
await expect(page.getByText('You cannot submit your data until you fix the issues')).toBeVisible()
const itemsLocator = page.locator('.govuk-error-summary ul li')
expect(await itemsLocator.count()).toBe(1)
await expect(itemsLocator).toContainText('description column is missing')
</shell_result>
<h1 class="govuk-heading-xl">
Check your answers before submitting your dataset
</h1>
{{ govukSummaryList({
...
}) }}
<h2 class="govuk-heading-m">
Now submit your dataset
</h2>
<p class="govuk-body">
</shell_result>
<span class="js-step-title">
Submit your data
</span>
</h2>
</div>
...
<div class="gem-c-step-nav__panel js-panel" id="step-panel-submit-your-data-4">
{% if 'submitEndpointForm' | isFeatureEnabled %}
<p class="gem-c-step-nav__paragraph"><a href="{{ organisation | endpointSubmissionFormToolDeepLink(dataset) }}">Submit your data</a> to the Planning
Data Platform. You need to provide your:</p>
<ul class="govuk-list govuk-list--bullet">
</shell_result>
{% if 'submitEndpointForm' | isFeatureEnabled %}
2: Submit your data
Submit your data to the Planning Data Platform. You need to provide your:
- full name
- work email address
</shell_result>
Update check-answers.html - change "submitting" to "providing" in heading
sed -i 's/Check your answers before submitting your dataset/Check your answers before providing your dataset/g' src/views/submit/check-answers.html
Update check-answers.html - change "submit" to "provide" in second heading
sed -i 's/Now submit your dataset/Now provide your dataset/g' src/views/submit/check-answers.html
Update get-started.html - change "Submit your data" to "Provide your data" in step title
sed -i 's/Submit your data/Provide your data/g' src/views/organisations/get-started.html
Update confirmation.html - change "Submit your data" to "Provide your data" in heading and link
sed -i 's/## 2: Submit your data/## 2: Provide your data/g' src/views/check/confirmation.html
sed -i 's/>Submit your data to the Planning Data Platform/>Provide your data to the Planning Data Platform/g' src/views/check/confirmation.html
Update issueDetails.html - change criteria labels
sed -i 's/You cannot submit your data until you fix the issues/You cannot provide your data until you fix the issues/g' src/views/check/results/issueDetails.html
sed -i 's/You can submit your data and fix these issues later/You can provide your data and fix these issues later/g' src/views/check/results/issueDetails.html
</changeScript></rawResChunk> -->
<!-- <rawResChunk><planSummary>- Update multiple files by replacing all instances of "submit your data" with "provide your data" to ensure consistent terminology in user-facing text, including headings, links, criteria labels, and test assertions.</planSummary></rawResChunk> -->
<!-- This is an auto-generated reply by CodeRabbit -->
Content tweaks as per service name from 'submit' to 'provide'
Description
Content wording changes from 'submit' to 'provide' as reflective of new service name
What type of PR is this? (check all applicable)
Related Tickets & Documents
#1013
QA Instructions, Screenshots, Recordings
Before
Before screenshot here
After
After screenshot here
Added/updated tests?
We encourage you to keep the code coverage percentage at 80% and above.
QA sign off
[optional] Are there any post-deployment tasks we need to perform?
[optional] Are there any dependencies on other PRs or Work?
Summary by CodeRabbit